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
show all
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: 10 origination routes per Amazon Chime Voice Connector.

Instance Attribute Summary collapse

Instance Attribute Details

#hostString

The FODN or IP address to contact for origination traffic.

Returns:

  • (String)


1806
1807
1808
1809
1810
1811
1812
1813
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1806

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

#portInteger

The designated origination route port. Defaults to 5060.

Returns:

  • (Integer)


1806
1807
1808
1809
1810
1811
1812
1813
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1806

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

#priorityInteger

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

Returns:

  • (Integer)


1806
1807
1808
1809
1810
1811
1812
1813
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1806

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

#protocolString

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

Returns:

  • (String)


1806
1807
1808
1809
1810
1811
1812
1813
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1806

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

#weightInteger

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

Returns:

  • (Integer)


1806
1807
1808
1809
1810
1811
1812
1813
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1806

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