Class: Aws::MediaConnect::Types::Flow

Inherits:

Struct

• Object
• Struct
• Aws::MediaConnect::Types::Flow

Defined in:

gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb

Overview

The settings for a flow, including its source, outputs, and entitlements.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #availability_zone ⇒ String

  The Availability Zone that you want to create the flow in.

• #description ⇒ String

  A description of the flow.

• #egress_ip ⇒ String

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

• #encoding_config ⇒ Types::EncodingConfig

  The encoding configuration to apply to the NDI® source when transcoding it to a transport stream for downstream distribution.

• #entitlements ⇒ Array<Types::Entitlement>

  The entitlements in this flow.

• #flow_arn ⇒ String

  The Amazon Resource Name (ARN) of the flow.

• #flow_size ⇒ String

  Determines the processing capacity and feature set of the flow.

• #maintenance ⇒ Types::Maintenance

  The maintenance settings for the flow.

• #media_streams ⇒ Array<Types::MediaStream>

  The media streams that are associated with the flow.

• #name ⇒ String

  The name of the flow.

• #ndi_config ⇒ Types::NdiConfig

  Specifies the configuration settings for a flow's NDI source or output.

• #outputs ⇒ Array<Types::Output>

  The outputs in this flow.

• #source ⇒ Types::Source

  The source for the flow.

• #source_failover_config ⇒ Types::FailoverConfig

  The settings for the source failover.

• #source_monitoring_config ⇒ Types::MonitoringConfig

  The settings for source monitoring.

• #sources ⇒ Array<Types::Source>

  The settings for the sources that are assigned to the flow.

• #status ⇒ String

  The current status of the flow.

• #vpc_interfaces ⇒ Array<Types::VpcInterface>

  The VPC Interfaces for this flow.

Instance Attribute Details

#availability_zone ⇒ String

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the flow. This value is not used or seen outside of the current MediaConnect account.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#egress_ip ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#encoding_config ⇒ Types::EncodingConfig

The encoding configuration to apply to the NDI® source when transcoding it to a transport stream for downstream distribution.

Returns:

• (Types::EncodingConfig)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#entitlements ⇒ Array<Types::Entitlement>

The entitlements in this flow.

Returns:

• (Array<Types::Entitlement>)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#flow_arn ⇒ String

The Amazon Resource Name (ARN) of the flow.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#flow_size ⇒ String

Determines the processing capacity and feature set of the flow.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance ⇒ Types::Maintenance

The maintenance settings for the flow.

Returns:

• (Types::Maintenance)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#media_streams ⇒ Array<Types::MediaStream>

The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.

Returns:

• (Array<Types::MediaStream>)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the flow.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#ndi_config ⇒ Types::NdiConfig

Specifies the configuration settings for a flow's NDI source or output. Required when the flow includes an NDI source or output.

Returns:

• (Types::NdiConfig)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#outputs ⇒ Array<Types::Output>

The outputs in this flow.

Returns:

• (Array<Types::Output>)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::Source

The source for the flow.

Returns:

• (Types::Source)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#source_failover_config ⇒ Types::FailoverConfig

The settings for the source failover.

Returns:

• (Types::FailoverConfig)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#source_monitoring_config ⇒ Types::MonitoringConfig

The settings for source monitoring.

Returns:

• (Types::MonitoringConfig)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#sources ⇒ Array<Types::Source>

The settings for the sources that are assigned to the flow.

Returns:

• (Array<Types::Source>)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the flow.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_interfaces ⇒ Array<Types::VpcInterface>

The VPC Interfaces for this flow.

Returns:

• (Array<Types::VpcInterface>)

# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 2612

class Flow < Struct.new(
  :availability_zone,
  :description,
  :egress_ip,
  :entitlements,
  :flow_arn,
  :media_streams,
  :name,
  :outputs,
  :source,
  :source_failover_config,
  :sources,
  :status,
  :vpc_interfaces,
  :maintenance,
  :source_monitoring_config,
  :flow_size,
  :ndi_config,
  :encoding_config)
  SENSITIVE = []
  include Aws::Structure
end