You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Chime::Types::OriginationRoute

Inherits:

Struct

• Object
• Struct
• Aws::Chime::Types::OriginationRoute

Defined in:

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

Overview

Note:

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

{
  host: "String",
  port: 1,
  protocol: "TCP", # accepts TCP, UDP
  priority: 1,
  weight: 1,
}

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #host ⇒ String

  The FQDN or IP address to contact for origination traffic.

• #port ⇒ Integer

  The designated origination route port.

• #priority ⇒ Integer

  The priority associated with the host, with 1 being the highest priority.

• #protocol ⇒ String

  The protocol to use for the origination route.

• #weight ⇒ Integer

  The weight associated with the host.

Instance Attribute Details

#host ⇒ String

The FQDN or IP address to contact for origination traffic.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2164

class OriginationRoute < Struct.new(
  :host,
  :port,
  :protocol,
  :priority,
  :weight)
  include Aws::Structure
end

#port ⇒ Integer

The designated origination route port. Defaults to 5060.

Returns:

• (Integer)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2164

class OriginationRoute < Struct.new(
  :host,
  :port,
  :protocol,
  :priority,
  :weight)
  include Aws::Structure
end

#priority ⇒ Integer

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

Returns:

• (Integer)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2164

class OriginationRoute < Struct.new(
  :host,
  :port,
  :protocol,
  :priority,
  :weight)
  include Aws::Structure
end

#protocol ⇒ String

The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2164

class OriginationRoute < Struct.new(
  :host,
  :port,
  :protocol,
  :priority,
  :weight)
  include Aws::Structure
end

#weight ⇒ Integer

The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

Returns:

• (Integer)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2164

class OriginationRoute < Struct.new(
  :host,
  :port,
  :protocol,
  :priority,
  :weight)
  include Aws::Structure
end